Skip to content

docs: add CONTRIBUTING.md#308

Open
ymstar wants to merge 1 commit into
colbymchenry:mainfrom
ymstar:docs/add-contributing
Open

docs: add CONTRIBUTING.md#308
ymstar wants to merge 1 commit into
colbymchenry:mainfrom
ymstar:docs/add-contributing

Conversation

@ymstar
Copy link
Copy Markdown
Contributor

@ymstar ymstar commented May 22, 2026

Summary

  • Add CONTRIBUTING.md with environment setup, project structure, pipeline architecture, and step-by-step guides for common contribution types

What's included

  • Prerequisites & setup — Node version requirements, npm install, build & test commands
  • Project structure — annotated directory tree of src/
  • Pipeline overview — files → extraction → resolution → graph → context
  • Contribution guides for:
    • Adding a new language (6-file checklist)
    • Adding a new framework resolver
    • Adding a new agent installer target
    • Improving search quality
  • Build/test/style conventions

This addresses the lack of contributor documentation noted in discussions around the project's onboarding experience.

…guide

Provides new contributors with environment setup, project structure
overview, pipeline architecture, and step-by-step guides for common
contribution types (new languages, framework resolvers, agent targets).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant